Pular para o conteúdo principal

Cancelar uma autorização

Use este ponto de extremidade para cancelar uma autorização Pix Automática

Request​

POST 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/authorizations/:identifier'

Headers​

NameDescription                            
x-delbank-api-keyRequired. API key

Body​

{
    "id": "RR123456782024042912345678901",
    "debtorDocument": "12345678000199",
    "cancelReason": 6
}

Resposta​

O código de status 200 indica sucesso na consulta.

Se a consulta for bem-sucedida, o retorno terá os seguintes campos em formato JSON:

{
"id":"RR0435879820240605njua7shf40o",
"cancelId":"IC0435879820240605bcdb1fhn43a",
"cancelDate":"2024-06-13T10:10:06.101Z"
}

Obter autorização cancelada​

Este endpoint irá buscar uma autorização cancelada

Request​

GET 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/authorizations/:authorizationIdentifier/cancellations/:cancellationIdentifier'

Headers​

NameDescription                            
x-delbank-api-keyRequired. API key

Path Parameters:​

NameTypeDescription
authorizationIdentifierstringObrigatório. Identificador de autorização
cancellationIdentifierstringObrigatório. Identificador de cancelamento

Resposta​

O código de status 200 indica sucesso na consulta.

Se a consulta for bem-sucedida, o retorno terá os seguintes campos em formato JSON:

{
"id":"RR0435879820240605njua7shf40o",
"cancelId":"IC0435879820240605bcdb1fhn43a",
"debtorDocument":77379362038,
"cancelReason":6,
"cancelDate":"2024-09-17T10:10:06.101Z",
"cancelStatus":0
}